home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1997 April / macformat-049.iso / mac / Shareware Plus / Developers / dropg++ / usr / include / net / route.h < prev    next >
Encoding:
C/C++ Source or Header  |  1997-02-20  |  10.3 KB  |  262 lines  |  [TEXT/R*ch]
  1. /*
  2.  * Copyright (c) 1980, 1986, 1993
  3.  *    The Regents of the University of California.  All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  * 1. Redistributions of source code must retain the above copyright
  9.  *    notice, this list of conditions and the following disclaimer.
  10.  * 2. Redistributions in binary form must reproduce the above copyright
  11.  *    notice, this list of conditions and the following disclaimer in the
  12.  *    documentation and/or other materials provided with the distribution.
  13.  * 3. All advertising materials mentioning features or use of this software
  14.  *    must display the following acknowledgement:
  15.  *    This product includes software developed by the University of
  16.  *    California, Berkeley and its contributors.
  17.  * 4. Neither the name of the University nor the names of its contributors
  18.  *    may be used to endorse or promote products derived from this software
  19.  *    without specific prior written permission.
  20.  *
  21.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31.  * SUCH DAMAGE.
  32.  *
  33.  *    @(#)route.h    8.3 (Berkeley) 4/19/94
  34.  */
  35.  
  36. /*
  37.  * Kernel resident routing tables.
  38.  * 
  39.  * The routing tables are initialized when interface addresses
  40.  * are set by making entries for all directly connected interfaces.
  41.  */
  42.  
  43. /*
  44.  * A route consists of a destination address and a reference
  45.  * to a routing entry.  These are often held by protocols
  46.  * in their control blocks, e.g. inpcb.
  47.  */
  48. struct route {
  49.     struct    rtentry *ro_rt;
  50.     struct    sockaddr ro_dst;
  51. };
  52.  
  53. /*
  54.  * These numbers are used by reliable protocols for determining
  55.  * retransmission behavior and are included in the routing structure.
  56.  */
  57. struct rt_metrics {
  58.     u_long    rmx_locks;    /* Kernel must leave these values alone */
  59.     u_long    rmx_mtu;    /* MTU for this path */
  60.     u_long    rmx_hopcount;    /* max hops expected */
  61.     u_long    rmx_expire;    /* lifetime for route, e.g. redirect */
  62.     u_long    rmx_recvpipe;    /* inbound delay-bandwith product */
  63.     u_long    rmx_sendpipe;    /* outbound delay-bandwith product */
  64.     u_long    rmx_ssthresh;    /* outbound gateway buffer limit */
  65.     u_long    rmx_rtt;    /* estimated round trip time */
  66.     u_long    rmx_rttvar;    /* estimated rtt variance */
  67.     u_long    rmx_pksent;    /* packets sent using this route */
  68. };
  69.  
  70. /*
  71.  * rmx_rtt and rmx_rttvar are stored as microseconds;
  72.  * RTTTOPRHZ(rtt) converts to a value suitable for use
  73.  * by a protocol slowtimo counter.
  74.  */
  75. #define    RTM_RTTUNIT    1000000    /* units for rtt, rttvar, as units per sec */
  76. #define    RTTTOPRHZ(r)    ((r) / (RTM_RTTUNIT / PR_SLOWHZ))
  77.  
  78. /*
  79.  * We distinguish between routes to hosts and routes to networks,
  80.  * preferring the former if available.  For each route we infer
  81.  * the interface to use from the gateway address supplied when
  82.  * the route was entered.  Routes that forward packets through
  83.  * gateways are marked so that the output routines know to address the
  84.  * gateway rather than the ultimate destination.
  85.  */
  86. #ifndef RNF_NORMAL
  87. #include <net/radix.h>
  88. #endif
  89. struct rtentry {
  90.     struct    radix_node rt_nodes[2];    /* tree glue, and other values */
  91. #define    rt_key(r)    ((struct sockaddr *)((r)->rt_nodes->rn_key))
  92. #define    rt_mask(r)    ((struct sockaddr *)((r)->rt_nodes->rn_mask))
  93.     struct    sockaddr *rt_gateway;    /* value */
  94.     short    rt_flags;        /* up/down?, host/net */
  95.     short    rt_refcnt;        /* # held references */
  96.     u_long    rt_use;            /* raw # packets forwarded */
  97.     struct    ifnet *rt_ifp;        /* the answer: interface to use */
  98.     struct    ifaddr *rt_ifa;        /* the answer: interface to use */
  99.     struct    sockaddr *rt_genmask;    /* for generation of cloned routes */
  100.     caddr_t    rt_llinfo;        /* pointer to link level info cache */
  101.     struct    rt_metrics rt_rmx;    /* metrics used by rx'ing protocols */
  102.     struct    rtentry *rt_gwroute;    /* implied entry for gatewayed routes */
  103. };
  104.  
  105. /*
  106.  * Following structure necessary for 4.3 compatibility;
  107.  * We should eventually move it to a compat file.
  108.  */
  109. struct ortentry {
  110.     u_long    rt_hash;        /* to speed lookups */
  111.     struct    sockaddr rt_dst;    /* key */
  112.     struct    sockaddr rt_gateway;    /* value */
  113.     short    rt_flags;        /* up/down?, host/net */
  114.     short    rt_refcnt;        /* # held references */
  115.     u_long    rt_use;            /* raw # packets forwarded */
  116.     struct    ifnet *rt_ifp;        /* the answer: interface to use */
  117. };
  118.  
  119. #define    RTF_UP        0x1        /* route usable */
  120. #define    RTF_GATEWAY    0x2        /* destination is a gateway */
  121. #define    RTF_HOST    0x4        /* host entry (net otherwise) */
  122. #define    RTF_REJECT    0x8        /* host or net unreachable */
  123. #define    RTF_DYNAMIC    0x10        /* created dynamically (by redirect) */
  124. #define    RTF_MODIFIED    0x20        /* modified dynamically (by redirect) */
  125. #define RTF_DONE    0x40        /* message confirmed */
  126. #define RTF_MASK    0x80        /* subnet mask present */
  127. #define RTF_CLONING    0x100        /* generate new routes on use */
  128. #define RTF_XRESOLVE    0x200        /* external daemon resolves name */
  129. #define RTF_LLINFO    0x400        /* generated by ARP or ESIS */
  130. #define RTF_STATIC    0x800        /* manually added */
  131. #define RTF_BLACKHOLE    0x1000        /* just discard pkts (during updates) */
  132. #define RTF_PROTO2    0x4000        /* protocol specific routing flag */
  133. #define RTF_PROTO1    0x8000        /* protocol specific routing flag */
  134.  
  135.  
  136. /*
  137.  * Routing statistics.
  138.  */
  139. struct    rtstat {
  140.     short    rts_badredirect;    /* bogus redirect calls */
  141.     short    rts_dynamic;        /* routes created by redirects */
  142.     short    rts_newgateway;        /* routes modified by redirects */
  143.     short    rts_unreach;        /* lookups which failed */
  144.     short    rts_wildcard;        /* lookups satisfied by a wildcard */
  145. };
  146. /*
  147.  * Structures for routing messages.
  148.  */
  149. struct rt_msghdr {
  150.     u_short    rtm_msglen;    /* to skip over non-understood messages */
  151.     u_char    rtm_version;    /* future binary compatibility */
  152.     u_char    rtm_type;    /* message type */
  153.     u_short    rtm_index;    /* index for associated ifp */
  154.     int    rtm_flags;    /* flags, incl. kern & message, e.g. DONE */
  155.     int    rtm_addrs;    /* bitmask identifying sockaddrs in msg */
  156.     pid_t    rtm_pid;    /* identify sender */
  157.     int    rtm_seq;    /* for sender to identify action */
  158.     int    rtm_errno;    /* why failed */
  159.     int    rtm_use;    /* from rtentry */
  160.     u_long    rtm_inits;    /* which metrics we are initializing */
  161.     struct    rt_metrics rtm_rmx; /* metrics themselves */
  162. };
  163.  
  164. #define RTM_VERSION    3    /* Up the ante and ignore older versions */
  165.  
  166. #define RTM_ADD        0x1    /* Add Route */
  167. #define RTM_DELETE    0x2    /* Delete Route */
  168. #define RTM_CHANGE    0x3    /* Change Metrics or flags */
  169. #define RTM_GET        0x4    /* Report Metrics */
  170. #define RTM_LOSING    0x5    /* Kernel Suspects Partitioning */
  171. #define RTM_REDIRECT    0x6    /* Told to use different route */
  172. #define RTM_MISS    0x7    /* Lookup failed on this address */
  173. #define RTM_LOCK    0x8    /* fix specified metrics */
  174. #define RTM_OLDADD    0x9    /* caused by SIOCADDRT */
  175. #define RTM_OLDDEL    0xa    /* caused by SIOCDELRT */
  176. #define RTM_RESOLVE    0xb    /* req to resolve dst to LL addr */
  177. #define RTM_NEWADDR    0xc    /* address being added to iface */
  178. #define RTM_DELADDR    0xd    /* address being removed from iface */
  179. #define RTM_IFINFO    0xe    /* iface going up/down etc. */
  180.  
  181. #define RTV_MTU        0x1    /* init or lock _mtu */
  182. #define RTV_HOPCOUNT    0x2    /* init or lock _hopcount */
  183. #define RTV_EXPIRE    0x4    /* init or lock _hopcount */
  184. #define RTV_RPIPE    0x8    /* init or lock _recvpipe */
  185. #define RTV_SPIPE    0x10    /* init or lock _sendpipe */
  186. #define RTV_SSTHRESH    0x20    /* init or lock _ssthresh */
  187. #define RTV_RTT        0x40    /* init or lock _rtt */
  188. #define RTV_RTTVAR    0x80    /* init or lock _rttvar */
  189.  
  190. /*
  191.  * Bitmask values for rtm_addr.
  192.  */
  193. #define RTA_DST        0x1    /* destination sockaddr present */
  194. #define RTA_GATEWAY    0x2    /* gateway sockaddr present */
  195. #define RTA_NETMASK    0x4    /* netmask sockaddr present */
  196. #define RTA_GENMASK    0x8    /* cloning mask sockaddr present */
  197. #define RTA_IFP        0x10    /* interface name sockaddr present */
  198. #define RTA_IFA        0x20    /* interface addr sockaddr present */
  199. #define RTA_AUTHOR    0x40    /* sockaddr for author of redirect */
  200. #define RTA_BRD        0x80    /* for NEWADDR, broadcast or p-p dest addr */
  201.  
  202. /*
  203.  * Index offsets for sockaddr array for alternate internal encoding.
  204.  */
  205. #define RTAX_DST    0    /* destination sockaddr present */
  206. #define RTAX_GATEWAY    1    /* gateway sockaddr present */
  207. #define RTAX_NETMASK    2    /* netmask sockaddr present */
  208. #define RTAX_GENMASK    3    /* cloning mask sockaddr present */
  209. #define RTAX_IFP    4    /* interface name sockaddr present */
  210. #define RTAX_IFA    5    /* interface addr sockaddr present */
  211. #define RTAX_AUTHOR    6    /* sockaddr for author of redirect */
  212. #define RTAX_BRD    7    /* for NEWADDR, broadcast or p-p dest addr */
  213. #define RTAX_MAX    8    /* size of array to allocate */
  214.  
  215. struct rt_addrinfo {
  216.     int    rti_addrs;
  217.     struct    sockaddr *rti_info[RTAX_MAX];
  218. };
  219.  
  220. struct route_cb {
  221.     int    ip_count;
  222.     int    ns_count;
  223.     int    iso_count;
  224.     int    any_count;
  225. };
  226.  
  227. #ifdef KERNEL
  228. #define    RTFREE(rt) \
  229.     if ((rt)->rt_refcnt <= 1) \
  230.         rtfree(rt); \
  231.     else \
  232.         (rt)->rt_refcnt--;
  233.  
  234. struct    route_cb route_cb;
  235. struct    rtstat    rtstat;
  236. struct    radix_node_head *rt_tables[AF_MAX+1];
  237.  
  238. void     route_init __P((void));
  239. int     route_output __P((struct mbuf *, struct socket *));
  240. int     route_usrreq __P((struct socket *,
  241.         int, struct mbuf *, struct mbuf *, struct mbuf *));
  242. void     rt_ifmsg __P((struct ifnet *));
  243. void     rt_maskedcopy __P((struct sockaddr *,
  244.         struct sockaddr *, struct sockaddr *));
  245. void     rt_missmsg __P((int, struct rt_addrinfo *, int, int));
  246. void     rt_newaddrmsg __P((int, struct ifaddr *, int, struct rtentry *));
  247. int     rt_setgate __P((struct rtentry *,
  248.         struct sockaddr *, struct sockaddr *));
  249. void     rt_setmetrics __P((u_long, struct rt_metrics *, struct rt_metrics *));
  250. void     rtable_init __P((void **));
  251. void     rtalloc __P((struct route *));
  252. struct rtentry *
  253.      rtalloc1 __P((struct sockaddr *, int));
  254. void     rtfree __P((struct rtentry *));
  255. int     rtinit __P((struct ifaddr *, int, int));
  256. int     rtioctl __P((int, caddr_t, struct proc *));
  257. int     rtredirect __P((struct sockaddr *, struct sockaddr *,
  258.         struct sockaddr *, int, struct sockaddr *, struct rtentry **));
  259. int     rtrequest __P((int, struct sockaddr *,
  260.         struct sockaddr *, struct sockaddr *, int, struct rtentry **));
  261. #endif
  262.